home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 July / EnigmA AMIGA RUN 20 (1997)(G.R. Edizioni)(IT)[!][issue 1997-07 & 08][EAR-CD IV].iso / earcd / misc / emu / masterge.lha / MG.doc < prev    next >
Text File  |  1997-03-14  |  9KB  |  218 lines
  1.                          ******* MasterGear *******
  2.            The Portable SEGA Mark3/MasterSystem/GameGear Emulator 
  3.                           version 1.0 (12/06/1996)
  4.  
  5.                              by Marat Fayzullin
  6.  
  7.  
  8.                          email: fms@freeflight.com
  9.                                 IRC: RST38h
  10.                     WWW: http://www.freeflight.com/fms/
  11.  
  12.  
  13.  
  14.  
  15.                                * DICLAIMERS *
  16.  
  17. * MasterSystem and GameGear are registered trademarks of SEGA.
  18. * The author is in no way affiliated with SEGA.
  19. * The author is in no way affiliated with any pirate group out there.
  20. * The author can not provide you with MasterSystem/GameGear games.
  21.  
  22.  
  23.  
  24.                          * NEW IN THIS VERSION *
  25.  
  26. * -delay option now allows to fix problems with GPRider, etc.
  27. * Sprites are now updated line-by-line, which fixed MickAndMack,
  28.   GunstarHeroes, and SonicDrift2.
  29. * Overall speed improvement, especially in the MSDOS port.
  30. * Music is saved in the .SND format, player included.
  31. * MSDOS port has got noise emulation, although not perfect one.
  32. * Code structure has significantly changed.
  33. * Improved Z80 disassembler.
  34.  
  35.  
  36.  
  37.                             * INTRODUCTION *
  38.  
  39.   MasterGear is a portable emulator of two SEGA game consoles: the
  40. MasterSystem (known as Mark3 in Japan) and the portable GameGear which is
  41. basically an improved MasterSystem in a smaller package. The emulator is
  42. written in C and therefore can be ported to any computer platform out
  43. there, given that this platform can run 32-bit applications. You can
  44. always get the latest MasterGear binaries and support files from
  45.  
  46.                  http://www.freeflight.com/fms/MG/
  47.  
  48.   At this moment, MG is able to run about 95% of the SMS/GG carts I have,
  49. although the emulation is still far from perfection. With the help from
  50. friends I hope to make it as close to original machines as possible. 
  51.  
  52.   If you have any information on the MasterSystem/GameGear, or the
  53. ROM-images which can be used for testing, and are willing to help, feel
  54. free to send mail to fms@freeflight.com. Any *intelligent* help is greatly
  55. appreciated :).
  56.  
  57.   The following games have problems when running on MG:
  58.  
  59.   GP Rider             - The road sometimes gets distorted. Garbage when
  60.                          selecting the motorcycle. Use -delay to fix it,
  61.                          at least partially.
  62.   XMen                 - Use -vperiod 7500.
  63.   Altered Beast        - Restarts at the title. Use -vperiod 8500.
  64.   Dynamite Headdy      - Screen sometimes blinks. Use -vperiod 10000. 
  65.   Galaxy Force         - Some garbage at the top of a screen in the
  66.                          Green World.
  67.   Alex Kidd Lost Stars - Palette gets reset to zeroes.
  68.   Surfing Ninjas       - Garbage at the title screens.
  69.   Sonic Drift 2        - Screen sometimes blinks.
  70.   Mickey Mouse GG      - Some problems after being killed in the
  71.                          second level.
  72.   Mahjong GG           - Distorted screen.
  73.   Astro Warrior        - Remains of blown cannons are distorted.
  74.  
  75.   If you find a cause of any bugs mentioned above, or know of any other
  76. game having problems, send me email. GP Rider, Astro Warrior and Mahjong 
  77. bugs appear to be caused by a special handling of VRAM accesses when the 
  78. second byte of VRAM address has two upper bits reset (normally, you need 
  79. to set them to 01 for VRAM access). It is not clear how this works.
  80.  
  81.  
  82.  
  83.                              * BUTTONS *
  84.  
  85.   MasterGear is controlled by following buttons:
  86.  
  87.   [SPACE]    - FIRE-A button (also: [LALT],A,S,D,F,G,H,J,K,L)
  88.   [LCONTROL] - FIRE-B button (also: Z,X,C,V,B,N,M)
  89.   [ENTER]    - START button (only in GameGear mode)
  90.   [TAB]      - RESET button (only in MasterSystem mode)
  91.   [BACKSPC]  - PAUSE button (only in MasterSystem mode)
  92.   [ESC]      - Quit emulation (also: [F12])
  93.   [SHIFT] and [CAPSLOCK] switch between MasterSystem joypads
  94.  
  95.   [1]-[4]    - Turn sound channels on/off
  96.   [0]        - Toggle all sound on/off
  97.   [-]        - Decrease sound volume
  98.   [+]        - Increase sound volume
  99.   [F1]       - Turn tracing on/off
  100.   [F2]       - Toggle joystick 1 on/off
  101.   [F3]       - Toggle joystick 2 on/off
  102.   [F4]       - Make a screen snapshot (SNAPxxxx.GIF)
  103.  
  104.  
  105.  
  106.                       * COMMAND LINE OPTIONS *
  107.  
  108.   MasterGear can be started with options described below. Be aware that
  109. not all of these options may be present in your particular version of MG. 
  110. Do "mg -help" for the list of options in your version. 
  111.  
  112.   -verbose <level>    - Select debugging messages [1]
  113.                          0 - Silent             1 - Startup messages
  114.                          2 - Illegal accesses   4 - Illegal Z80 ops
  115.                          8 - Bank switching    16 - Sound
  116.                         32 - VDP registers
  117.   -vperiod <period>   - Set VBlank period [8000ops]
  118.   -uperiod <period>   - Number of interrupts per screen update [2]
  119.   -help               - Print this help page
  120.   -sms/-gg            - Run in MasterSystem/GameGear mode [-sms]
  121.                         (overrides .SMS/.GG file extensions)
  122.   -engl/-jap          - Run in English/Japanese mode [-engl]
  123.                         (overrides country code in GG carts)
  124.   -autoa/-noautoa     - Autofire/No autofire for button A [-noautoa]
  125.   -autob/-noautob     - Autofire/No autofire for button B [-noautob]
  126.   -delay/-nodelay     - Delay/Don't delay VRAM reads [-nodelay]
  127.   -logsnd <filename>  - Write soundtrack to a file [off]
  128.   -trap <address>     - Trap execution when PC reaches address [FFFFh]
  129.   -sound [<quality>]  - Emulate sound with given quality [-nosound]
  130.                         0 - Off              7 - Highest quality
  131.                         (4 assumed if no quality was given)
  132.   -nosound            - Don't emulate sound [-nosound]
  133.   -shm/-noshm         - Use/Don't use MIT SHM extensions for X [-shm]
  134.   -saver/-nosaver     - Save/Don't save CPU when inactive [-saver]
  135.   -back <filename>    - Use <filename> as background picture [MG.GIF]
  136.   -vsync/-novsync     - Sync/Don't sync screen updates [-novsync]
  137.  
  138.  
  139.  
  140.                              * NOTES *
  141.  
  142.   The SMS/GG programming information will be available soon at
  143. ftp.komkon.org. Both are nice little machines, logically structured and
  144. much less weird than Nintendo hardware. The CPU used is Z80, the original
  145. one, with no custom changes. Video controller seems to be based on a well
  146. known TMS9918/9928 (MSX,Coleco,TI99/4), but has only one screenmode (as
  147. far as I know), and is thoroughfully mutated in some other aspects. There 
  148. is no BIOS ROM as in MSX or ColecoVision.
  149.  
  150.   MasterGear comes without any ROM images due to copyright reasons. 
  151. Please, *do not* send me mail asking for ROM images: I can not give you
  152. any, no matter how strongly you desire to get them. MasterGear works with
  153. plain "raw" ROM images, and therefore the default file extension is .ROM. 
  154. It may be a wise idea to use .SMS and .GG extensions to distinguish
  155. between MasterSystem and GameGear ROMs though: the choice of extension is
  156. not limited in any way.
  157.  
  158.   Some copiers add a 512-byte header to the ROM image files they create. 
  159. If you see a ROM image whose size is a multiple of 16384 bytes + 512,
  160. simply cut off the first 512 bytes to et the raw image. Unix users can do 
  161. it in a following way:
  162.  
  163.             dd if=<input-file> of=<output-file> skip=1 bs=512
  164.  
  165.   If you want to get a bigger window in MasterGear-Unix/X, or your Xserver
  166. is 16/24bit (the generic version of MasterGear only supports 256-color
  167. Xservers), check out the improved Unix/X drivers by Ian Spielman,
  168. available at
  169.  
  170.                   http://hepserver.nhn.uoknor.edu/
  171.  
  172.   When compiled with ZLIB option, MasterGear will be able to transparently
  173. handle files packed with GZIP and ZIP, which helps to save the disk space.
  174. You will need the ZLib library by Jean-loup Gailly and Mark Adler though.
  175. Its source is available at
  176.  
  177.                     http://quest.jpl.nasa.gov/zlib/
  178.  
  179.   The MSDOS version can be compiled with GIFLIB option. Then, it will
  180. allow you to load backdrop pictures from the .GIF files, and save screen
  181. snapshots into .GIF files by pressing [F4]. You will need the GIFLib
  182. library by Gershon Elber, available from SimTel and other archives. 
  183.  
  184.   Since version 0.6, MasterGear checks the file extension and forces
  185. emulation into MasterSystem or GameGear mode if extension is .SMS or .GG. 
  186. In the GameGear mode, the country code is also checked. If the cartridge
  187. is either for Japan or for US/Europe only, and there was no
  188. nationalization option given, the nationalization switch is forced into an
  189. appropriate state. 
  190.  
  191. That's it. Have fun!
  192.  
  193.  
  194.  
  195.                                * THANKS *
  196.  
  197.   I would like to thank Richard Aplin, Chris Shay, Neil Harding, who
  198. helped with invaluable technical information about MasterSystem and
  199. GameGear. Thanks also go to (alphabetically)
  200.  
  201. * Gershon Elber, author of GIFLib.
  202. * Marcel de Kogel, who helped me with the MSDOS port.
  203. * Alex Krasivsky, the initial author of Adlib sound driver on
  204.   which MG-DOS sound is based.
  205. * Juan Luis Lario for the pictures of GameGear.
  206. * James McKay, author of 'Massage'.
  207. * Authors of ZLib and Markus Oberhumer, who told me about ZLib.
  208. * Charles Scheffold and other authors of PMODE/W.
  209. * Ian Spielman, who wrote the enchanced Unix/X drivers for MG.
  210. * John Stiles, author of the MG port to Macintosh.
  211. * Unknown guy from .BR who showed me how to handle PC joystick.
  212. * Many other people who helped with information, bug reports,
  213.   and cart images for testing.
  214.  
  215.  
  216. ---------------
  217. Marat Fayzullin
  218.